<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
  <meta name="description" content="flutter_sound API docs, for the Dart programming language.">
  <title>flutter_sound - Dart API docs</title>


  
  <link rel="preconnect" href="https://fonts.gstatic.com">
  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
  <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0" rel="stylesheet">
  
  <link rel="stylesheet" href="static-assets/github.css?v1">
  <link rel="stylesheet" href="static-assets/styles.css?v1">
  <link rel="icon" href="static-assets/favicon.png?v1">

  
</head>


<body data-base-href="" data-using-base-href="false" class="light-theme">

<div id="overlay-under-drawer"></div>

<header id="title">
  <span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
  <ol class="breadcrumbs gt-separated dark hidden-xs">
    <li><a href="https://flutter-sound.canardoux.xyz/readme.html">flutter_sound package</a></li>
  </ol>
  <div class="self-name">flutter_sound</div>
  <form class="search navbar-right" role="search">
    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
  <div class="toggle" id="theme-button" title="Toggle brightness">
    <label for="theme">
      <input type="checkbox" id="theme" value="light-theme">
      <span id="dark-theme-button" class="material-symbols-outlined">
        dark_mode
      </span>
      <span id="light-theme-button" class="material-symbols-outlined">
        light_mode
      </span>
    </label>
  </div>
</header>
<main>

  <div id="dartdoc-main-content" class="main-content">
      
<section class="desc markdown">
  <p><img src="https://flutter-sound.canardoux.xyz/images/2-year-old-irish-girl-ukrainian.jpg" alt="PeaceForUkraine">
Peace for Ukraine</p>
<p><img src="https://flutter-sound.canardoux.xyz/images/banner.png" alt="PrayForUkraine">
Pray for Ukraine</p>
<ul>
<li>
<h2 id="flutter-sound-user-your-documentation-is-therehttpsflutter-soundcanardouxxyzreadmehtml">Flutter Sound user: your <a href="https://flutter-sound.canardoux.xyz/readme.html">documentation is there</a></h2>
</li>
<li>
<h2 id="the-changelog-file-is-herehttpsflutter-soundcanardouxxyzchangeloghtml">The <a href="https://flutter-sound.canardoux.xyz/changelog.html">CHANGELOG file is here</a></h2>
</li>
</ul>
<hr>
<p><img src="https://user-images.githubusercontent.com/27461460/77531555-77c9ec00-6ed6-11ea-9813-320f943b08cc.gif" alt="Demo"></p>
<h2 id="overview">Overview</h2>
<p>Flutter Sound is a Flutter package allowing you to play and record audio for :</p>
<ul>
<li>Android</li>
<li>iOS</li>
<li>Flutter Web</li>
</ul>
<p>Flutter Sound provides both a high level API and widgets for:</p>
<ul>
<li>play audio</li>
<li>record audio</li>
</ul>
<p>Flutter Sound can be used to play a beep from an asset all the way up to implementing a complete media player.</p>
<p>This library is published under the Mozilla Public License MPL2.0.</p>
<p>If your App will be covered by the GPL License,
you probably want to consider using the GPL <a href="https://pub.dev/packages/tau_sound">Tau Sound Project 9.0</a> : Tau Sound 9.0 offers several enhancement compared to Flutter Sound 8.3.</p>
<h2 id="requirements">Requirements</h2>
<ul>
<li>Flutter Sound requires an iOS 10.0 SDK (or later)</li>
<li>Flutter Sound requires an Android API level 21 (or later)</li>
</ul>
<h2 id="features">Features</h2>
<p>The Flutter Sound package includes the following features</p>
<ul>
<li>Play and Record flutter sound or music with various codecs.</li>
<li>Play local or remote files specified by their URL.</li>
<li>Play assets.</li>
<li>Play audio using the built in SoundPlayerUI Widget.</li>
<li>Roll your own UI utilising the Flutter Sound api.</li>
<li>Record audio using the builtin SoundRecorderUI Widget.</li>
<li>Roll your own Recording UI utilising the Flutter Sound api.</li>
<li>Support for releasing/resuming resources when the app pauses/resumes.</li>
<li>Record to a Dart Stream</li>
<li>Playback from a Dart Stream</li>
<li>The App playback can be controled from the device lock screen or from an Apple watch</li>
</ul>
<h2 id="changelog">Changelog</h2>
<p>You can find the <a href="https://flutter-sound.canardoux.xyz/changelog.html">changes here</a></p>
<h2 id="documentation">Documentation</h2>
<p>The <a href="https://flutter-sound.canardoux.xyz/readme.html">documentation is here</a></p>
<h2 id="license">License</h2>
<ul>
<li>Flutter Sound is copyrighted by Dooboolab (2018, 2019, 2020, 2021).</li>
<li>Flutter Sound is released under the permissive Mozilla license which has a <strong>weak</strong> <em>copyleft</em> clause: if you modify some of Flutter Sound code you must publish your modifications under the MPL license too. But you may publish your App with any license you want. Even a Proprietary/Close Sources License (shame on you!).</li>
</ul>
<h2 id="help">Help</h2>
<p>I greatly appreciate any contributions to the project which can be as simple as providing feedback on the API or documentation.</p>
<p><a href="https://www.buymeacoffee.com/larpoux"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&amp;emoji=💛&amp;slug=larpoux&amp;button_colour=5F7FFF&amp;font_colour=ffffff&amp;font_family=Cookie&amp;outline_colour=000000&amp;coffee_colour=FFDD00"></a>
<a href="https://paypal.me/thetauproject?locale.x=fr_FR"><img src="https://www.paypalobjects.com/webstatic/mktg/Logo/pp-logo-100px.png" alt="Paypal"></a></p>
<h2 id="you-can-also-click-on-the-thumb-up-button-of-the-top-of-the-pubdev-pagehttpspubdevpackagesflutter_sound-this-is-free-and-this-will-reassure-me-that-i-do-not-spend-most-of-my-life-for-nobody">You can also click on the "Thumb up" button of the top of the <a href="https://pub.dev/packages/flutter_sound">pub.dev page</a>. This is free and this will reassure me that <strong>I do not spend most of my life for nobody</strong>.</h2>
</section>


      <section class="summary">
          <h2>Libraries</h2>
        <dl>
        </dl>
      </section>

  </div> <!-- /.main-content -->

  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
    <!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
<header id="header-search-sidebar" class="hidden-l">
  <form class="search-sidebar" role="search">
    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
</header>

<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
    <li><a href="https://flutter-sound.canardoux.xyz/readme.html">flutter_sound package</a></li>
</ol>


    <h5 class="hidden-xs"><span class="package-name">flutter_sound</span> <span class="package-kind">package</span></h5>
    <ol>
      <li class="section-title">Libraries</li>
</ol>

  </div>

  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
  </div>

</main>

<footer>
  <span class="no-break">
    flutter_sound
      9.4.10
  </span>

  
</footer>



<script src="static-assets/highlight.pack.js?v1"></script>
<script src="static-assets/docs.dart.js"></script>



</body>

</html>

